Skip to content

MkInstallGuide

Show source on GitHub

Node to display an install guide.

Example: Regular

Jinja

{{ mk.MkInstallGuide() }}

Python

MkInstallGuide()

pip

The latest released version is available at the Python package index.

pip install mknodes

### pip

The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).

```` {.python }
pip install mknodes
````

Example: Explicit

Jinja

{{ "mkdocs" | MkInstallGuide(package_repos=["pip", "pipx"]) }}

Python

MkInstallGuide('mkdocs', package_repos=['pip', 'pipx'])

pip

The latest released version is available at the Python package index.

pip install mkdocs

pipx

pipx allows for the global installation of Python applications in isolated environments.

pipx install mkdocs

### pip

The latest released version is available at the [Python package index](https://pypi.org/project/mkdocs).

```` {.python }
pip install mkdocs
````
### pipx

[pipx](https://github.com/pypa/pipx) allows for the global installation of Python applications in isolated environments.

```` {.python }
pipx install mkdocs
````

<h3 id="pip">pip</h3>
<p>The latest released version is available at the <a href="https://pypi.org/project/mkdocs">Python package index</a>.</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">pip</span> <span class="n">install</span> <span class="n">mkdocs</span>
</span></code></pre></div>
<h3 id="pipx">pipx</h3>
<p><a href="https://github.com/pypa/pipx">pipx</a> allows for the global installation of Python applications in isolated environments.</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">pipx</span> <span class="n">install</span> <span class="n">mkdocs</span>
</span></code></pre></div>

MkInstallGuide
├── MkHeader('pip', level=3)
├── MkCode('pip install mkdocs')
│   ╰── MkText('pip install mkdocs')
├── MkHeader('pipx', level=3)
╰── MkCode('pipx install mkdocs')
    ╰── MkText('pipx install mkdocs')

Bases: MkTemplate

__init__ 

__init__(
    distribution: str | None = None,
    *,
    package_repos: list[installmethods.InstallMethodStr] | None = None,
    header_level: int = 3,
    **kwargs: Any
)

Parameters:

Name Type Description Default
distribution str | None

name of the distribution to install

 None
package_repos list[InstallMethodStr] | None

package repositories the project is available on

 None
header_level int

Header level for each section

 3
kwargs Any

Keyword arguments passed to parent

 {}
Name Children Inherits
MkTemplate
mknodes.templatenodes.mktemplate
Node representing a jinja template.		 
graph TD
  94854583277136["mkinstallguide.MkInstallGuide"]
  94854582782240["mktemplate.MkTemplate"]
  94854582919984["mkcontainer.MkContainer"]
  94854582916880["mknode.MkNode"]
  94854582838576["node.Node"]
  140544995341632["builtins.object"]
  94854582782240 --> 94854583277136
  94854582919984 --> 94854582782240
  94854582916880 --> 94854582919984
  94854582838576 --> 94854582916880
  140544995341632 --> 94854582838576
/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkinstallguide/metadata.toml
[metadata]
name = "MkInstallGuide"
icon = "mdi:help"
group = "documentation"
virtual_children = true

[examples.regular]
title = "Regular"
jinja = """
{{ mk.MkInstallGuide() }}
"""

[examples.explicit]
title = "Explicit"
jinja = """
{{ "mkdocs" | MkInstallGuide(package_repos=["pip", "pipx"]) }}
"""

[output.markdown]
template = """
{% for method in node.package_repos %}
{{ method.ID | MkHeader(level=node.header_level) }}

{{ method.info_text() }}

{{ method.install_instructions() | MkCode }}
{% endfor %}
"""

# proj = self.associated_distribution
# if method.ID == "pip" and proj and (extras := proj.info.extras):
#     extras_str = ",".join(extras)
#     text = f"{method.install_instructions()}[{extras_str}]"
#     code = mkcode.MkCode(text)
#     items.append(code)
mknodes.templatenodes.mkinstallguide.MkInstallGuide
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class MkInstallGuide(mktemplate.MkTemplate):
    """Node to display an install guide."""

    ICON = "material/help"
    VIRTUAL_CHILDREN = True

    def __init__(
        self,
        distribution: str | None = None,
        *,
        package_repos: list[installmethods.InstallMethodStr] | None = None,
        header_level: int = 3,
        **kwargs: Any,
    ):
        """Constructor.

        Arguments:
            distribution: name of the distribution to install
            package_repos: package repositories the project is available on
            header_level: Header level for each section
            kwargs: Keyword arguments passed to parent
        """
        super().__init__("output/markdown/template", **kwargs)
        self._distribution = distribution
        self.header_level = header_level
        self._package_repos = package_repos

    @property
    def package_repos(self) -> list[installmethods.InstallMethod]:
        if self._package_repos:
            return [
                installmethods.InstallMethod.by_id(i)(self.distribution)
                for i in self._package_repos
            ]
        return self.ctx.metadata.package_repos or []

    @property
    def distribution(self):
        return self._distribution or self.ctx.metadata.distribution_name

    @distribution.setter
    def distribution(self, value):
        self._distribution = value